ALMaSS  1.0
The Animal, Landscape and Man Simulation System
TALMaSSObject Class Reference

The base class of all ALMaSS objects requiring Step code. More...

#include <PopulationManager.h>

Inheritance diagram for TALMaSSObject:
TAnimal Bembidion_Base Goose_Base Hunter Newt_Base Partridge_Base Partridge_Covey Rabbit_Base Rabbit_Warren Roe_Base Skylark_Base THare TPredator Vole_Base

Public Member Functions

int GetCurrentStateNo ()
 Returns the current state number. More...
 
void SetCurrentStateNo (int a_num)
 Sets the current state number. More...
 
bool GetStepDone ()
 Returns the step done indicator flag. More...
 
void SetStepDone (bool a_bool)
 Sets the step done indicator flag. More...
 
virtual void BeginStep (void)
 BeingStep behaviour - must be implemented in descendent classes. More...
 
virtual void Step (void)
 Step behaviour - must be implemented in descendent classes. More...
 
virtual void EndStep (void)
 EndStep behaviour - must be implemented in descendent classes. More...
 
virtual void ReinitialiseObject ()
 Used to re-use an object - must be implemented in descendent classes. More...
 
 TALMaSSObject ()
 The constructor for TALMaSSObject. More...
 
virtual ~TALMaSSObject ()
 The destructor for TALMaSSObject. More...
 
void OnArrayBoundsError ()
 Used for debugging only, tests basic object properties. More...
 

Protected Attributes

int m_CurrentStateNo
 The basic state number for all objects - '-1' indicates death. More...
 
bool m_StepDone
 Indicates whether the iterative step code is done for this timestep. More...
 

Detailed Description

The base class of all ALMaSS objects requiring Step code.

Constructor & Destructor Documentation

◆ TALMaSSObject()

TALMaSSObject::TALMaSSObject ( )

The constructor for TALMaSSObject.

TALMaSSObject Constructor

1379  {
1380 #ifdef __CJTDebug_5
1381  AmAlive = 0xDEADC0DE;
1382 #endif
1383  m_StepDone = false;
1384  m_CurrentStateNo = 0;
1385 }
bool m_StepDone
Indicates whether the iterative step code is done for this timestep.
Definition: PopulationManager.h:118
int m_CurrentStateNo
The basic state number for all objects - '-1' indicates death.
Definition: PopulationManager.h:116

◆ ~TALMaSSObject()

TALMaSSObject::~TALMaSSObject ( )
virtual

The destructor for TALMaSSObject.

TALMaSSObject Destructor

1393  {
1394 #ifdef __CJTDebug_5
1395  AmAlive = 0;
1396 #endif
1397 }

Member Function Documentation

◆ BeginStep()

◆ EndStep()

◆ GetCurrentStateNo()

◆ GetStepDone()

bool TALMaSSObject::GetStepDone ( )
inline

Returns the step done indicator flag.

129  {
130  return m_StepDone;
131  }

References m_StepDone.

◆ OnArrayBoundsError()

void TALMaSSObject::OnArrayBoundsError ( )

Used for debugging only, tests basic object properties.

1427  {
1428  exit( 1 );
1429 }

Referenced by Skylark_Female::GetFood(), Skylark_Male::GetFood(), Skylark_Male::OnAddNestling(), Skylark_Male::OnNestlingDeath(), Skylark_Male::OnPreFledgelingDeath(), and Skylark_Male::OnPreFledgelingMature().

◆ ReinitialiseObject()

virtual void TALMaSSObject::ReinitialiseObject ( )
inlinevirtual

Used to re-use an object - must be implemented in descendent classes.

143  {
144  m_StepDone = false;
145  m_CurrentStateNo = 0;
146  }

References m_CurrentStateNo, and m_StepDone.

Referenced by Newt_Base::ReInit(), Bembidion_Base::ReInit(), Skylark_Base::ReInit(), Goose_Base::ReInit(), and TAnimal::ReinitialiseObject().

◆ SetCurrentStateNo()

void TALMaSSObject::SetCurrentStateNo ( int  a_num)
inline

Sets the current state number.

125  {
126  m_CurrentStateNo = a_num;
127  }

References m_CurrentStateNo.

◆ SetStepDone()

void TALMaSSObject::SetStepDone ( bool  a_bool)
inline

Sets the step done indicator flag.

133  {
134  m_StepDone = a_bool;
135  }

References m_StepDone.

◆ Step()

Member Data Documentation

◆ m_CurrentStateNo

int TALMaSSObject::m_CurrentStateNo
protected

The basic state number for all objects - '-1' indicates death.

Referenced by Partridge_Covey::AddMember(), Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Partridge_Chick::BeginStep(), Partridge_Covey::BeginStep(), Roe_Base::BeginStep(), Roe_Adult_Base::BeginStep(), Skylark_Nestling::BeginStep(), Partridge_Chick::ChDying(), Partridge_Chick::ChMaturing(), Partridge_Chick2::ChMaturing(), Partridge_Clutch::ClDeveloping(), Partridge_Clutch::ClDying(), Partridge_Clutch::EndStep(), Partridge_Chick::EndStep(), Partridge_Chick2::EndStep(), Partridge_Covey::EndStep(), Rabbit_Juvenile::EndStep(), Rabbit_Adult::EndStep(), Roe_Base::EndStep(), Roe_Adult_Base::EndStep(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), Roe_Fawn::FADie(), Roe_Female::FDie(), Partridge_Female::FDying(), GetCurrentStateNo(), Vole_Base::Init(), TAnimal::KillThis(), Partridge_Covey::ManagerCheckMerge(), Roe_Male::MDie(), Partridge_Male::MDying(), Goose_Base::On_Bang(), Hare_Juvenile::ON_Dead(), Hare_Male::ON_Dead(), Hare_Female::ON_Dead(), Skylark_Nestling::OnDeserted(), Skylark_Clutch::OnMumGone(), Skylark_Nestling::OnYouHaveBeenEaten(), Skylark_Base::ReInit(), Hare_Infant::ReInit(), Hare_Young::ReInit(), Hare_Juvenile::ReInit(), Hare_Male::ReInit(), Hare_Female::ReInit(), ReinitialiseObject(), Partridge_Covey::RemoveMember(), Partridge_Covey::SanityCheck(), SetCurrentStateNo(), Skylark_Base::Skylark_Base(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Newt_Female::st_Breed(), Bembidion_Base::st_Die(), THare::st_Dying(), Skylark_Clutch::st_Dying(), Skylark_Nestling::st_Dying(), Skylark_PreFledgeling::st_Dying(), Skylark_Female::st_Dying(), Skylark_Male::st_Dying(), Vole_Base::st_Dying(), Goose_Base::st_Dying(), Newt_Base::st_Dying(), Rabbit_Base::st_Dying(), Rabbit_Young::st_Dying(), Rabbit_Juvenile::st_Dying(), Rabbit_Adult::st_Dying(), Hare_Infant::st_NextStage(), Hare_Young::st_NextStage(), Hare_Juvenile::st_NextStage(), Newt_Egg::st_NextStage(), Newt_Larva::st_NextStage(), Newt_Juvenile::st_NextStage(), Bembidion_Egg_List::Step(), Bembidion_Larvae::Step(), Bembidion_Pupae::Step(), Bembidion_Adult::Step(), GooseHunter::Step(), Rabbit_Warren::Step(), Vole_JuvenileMale::Step(), Vole_Male::Step(), Goose_Barnacle_FamilyGroup::Step(), Goose_Barnacle_NonBreeder::Step(), Goose_Greylag_FamilyGroup::Step(), Goose_Greylag_NonBreeder::Step(), Goose_Pinkfoot_FamilyGroup::Step(), Goose_Pinkfoot_NonBreeder::Step(), Hare_Infant::Step(), Hare_Young::Step(), Hare_Juvenile::Step(), Hare_Male::Step(), Hare_Female::Step(), Newt_Egg::Step(), Newt_Larva::Step(), Newt_Juvenile::Step(), Newt_Male::Step(), Newt_Female::Step(), Partridge_Clutch::Step(), Partridge_Chick::Step(), Partridge_Chick2::Step(), Partridge_Male::Step(), Partridge_Female::Step(), Rabbit_Young::Step(), Rabbit_Juvenile::Step(), Rabbit_Male::Step(), Rabbit_Female::Step(), Roe_Base::Step(), Roe_Adult_Base::Step(), Weasel::Step(), and Owl::Step().

◆ m_StepDone

bool TALMaSSObject::m_StepDone
protected

Indicates whether the iterative step code is done for this timestep.

Referenced by Vole_JuvenileMale::BeginStep(), Vole_JuvenileFemale::BeginStep(), Hare_Infant::BeginStep(), Hare_Young::BeginStep(), Hare_Juvenile::BeginStep(), Hare_Male::BeginStep(), Hare_Female::BeginStep(), Skylark_Female::BeginStep(), Skylark_Male::BeginStep(), Partridge_Chick::ChDying(), Partridge_Chick::ChMaturing(), Partridge_Chick2::ChMaturing(), Partridge_Clutch::ClDeveloping(), Partridge_Clutch::ClDying(), Roe_Base::EndStep(), Skylark_Clutch::EndStep(), Skylark_Nestling::EndStep(), Skylark_PreFledgeling::EndStep(), Partridge_Female::FDying(), Hare_Female::GeneralOrganoPhosphate(), Hare_Male::GeneralOrganoPhosphate(), Rabbit_Base::GeneralOrganoPhosphate(), GetStepDone(), TAnimal::KillThis(), Partridge_Male::MDying(), Hare_Juvenile::ON_Dead(), Hare_Male::ON_Dead(), Hare_Female::ON_Dead(), ReinitialiseObject(), Partridge_Covey::RemoveMember(), SetStepDone(), Vole_JuvenileMale::st_BecomeSubAdult(), Vole_JuvenileFemale::st_BecomeSubAdult(), Bembidion_Base::st_Die(), THare::st_Dying(), Goose_Base::st_Dying(), Rabbit_Base::st_Dying(), Rabbit_Young::st_Dying(), Rabbit_Juvenile::st_Dying(), Rabbit_Adult::st_Dying(), Rabbit_Female::st_EvaluateTerritory(), Newt_Egg::st_NextStage(), Newt_Larva::st_NextStage(), Newt_Juvenile::st_NextStage(), Bembidion_Egg_List::Step(), Bembidion_Larvae::Step(), Bembidion_Pupae::Step(), Bembidion_Adult::Step(), GooseHunter::Step(), Rabbit_Warren::Step(), Vole_JuvenileMale::Step(), Vole_Male::Step(), Vole_JuvenileFemale::Step(), Vole_Female::Step(), Goose_Barnacle_FamilyGroup::Step(), Goose_Barnacle_NonBreeder::Step(), Goose_Greylag_FamilyGroup::Step(), Goose_Greylag_NonBreeder::Step(), Goose_Pinkfoot_FamilyGroup::Step(), Goose_Pinkfoot_NonBreeder::Step(), Hare_Infant::Step(), Hare_Young::Step(), Hare_Juvenile::Step(), Hare_Male::Step(), Hare_Female::Step(), Newt_Egg::Step(), Newt_Larva::Step(), Newt_Juvenile::Step(), Newt_Male::Step(), Newt_Female::Step(), Partridge_Clutch::Step(), Partridge_Chick::Step(), Partridge_Chick2::Step(), Partridge_Male::Step(), Partridge_Female::Step(), Partridge_Covey::Step(), Rabbit_Young::Step(), Rabbit_Juvenile::Step(), Rabbit_Male::Step(), Rabbit_Female::Step(), Roe_Base::Step(), Roe_Adult_Base::Step(), Roe_Fawn::Step(), Roe_Female::Step(), Roe_Male::Step(), Skylark_Clutch::Step(), Skylark_Nestling::Step(), Skylark_PreFledgeling::Step(), Skylark_Female::Step(), Skylark_Male::Step(), Weasel::Step(), and Owl::Step().


The documentation for this class was generated from the following files: